// 《围棋》作者版权所有。版权所有。
// 此源代码的使用受BSD样式
// 许可证的约束，该许可证可以在许可证文件中找到。

// go:generate go run make_tables.go 

// 包位实现位计数和操作
// 用于预声明无符号整数类型的函数。
package bits

const uintSize = 32 << (^uint(0) >> 63) // 32或64 

// UintSize是单元的大小，以位为单位。
const UintSize = uintSize

// --前导零--

// /前导零返回x中前导零位的个数；对于x==0，结果是UintSize。
func LeadingZeros(x uint) int { return UintSize - Len(x) }

// LeadingZeros8返回x中前导零位的个数；对于x==0，结果是8。
func LeadingZeros8(x uint8) int { return 8 - Len8(x) }

// 前导零16返回x中前导零位数；对于x==0，结果为16。
func LeadingZeros16(x uint16) int { return 16 - Len16(x) }

// 前导零32返回x中前导零位数；对于x==0，结果为32。
func LeadingZeros32(x uint32) int { return 32 - Len32(x) }

// 前导零64返回x中前导零位的个数；对于x==0，结果为64。
func LeadingZeros64(x uint64) int { return 64 - Len64(x) }

// --跟踪零--

// /参见http:
const deBruijn32 = 0x077CB531

var deBruijn32tab = [32]byte{
	0, 1, 28, 2, 29, 14, 24, 3, 30, 22, 20, 15, 25, 17, 4, 8,
	31, 27, 13, 23, 21, 19, 16, 7, 26, 12, 18, 6, 11, 5, 10, 9,
}

const deBruijn64 = 0x03f79d71b4ca8b09

var deBruijn64tab = [64]byte{
	0, 1, 56, 2, 57, 49, 28, 3, 61, 58, 42, 50, 38, 29, 17, 4,
	62, 47, 59, 36, 45, 43, 51, 22, 53, 39, 33, 30, 24, 18, 12, 5,
	63, 55, 48, 27, 60, 41, 37, 16, 46, 35, 44, 21, 52, 32, 23, 11,
	54, 26, 40, 15, 34, 20, 31, 10, 25, 14, 19, 9, 13, 8, 7, 6,
}

// TrailingZeros返回x中的尾随零位数；对于x==0，结果是UintSize。
func TrailingZeros(x uint) int {
	if UintSize == 32 {
		return TrailingZeros32(uint32(x))
	}
	return TrailingZeros64(uint64(x))
}

// TrailingZeros8返回x中的尾随零位数；对于x==0，结果是8。
func TrailingZeros8(x uint8) int {
	return int(ntz8tab[x])
}

// TrailingZeros16返回x中的尾随零位数；对于x==0，结果为16。
func TrailingZeros16(x uint16) int {
	if x == 0 {
		return 16
	}
	// 请参见TrailingZeros64中的注释
	return int(deBruijn32tab[uint32(x&-x)*deBruijn32>>(32-5)])
}

// TrailingZeros32返回x中的尾随零位数；对于x==0，结果为32。
func TrailingZeros32(x uint32) int {
	if x == 0 {
		return 32
	}
	// 请参阅TrailingZeros64中的注释
	return int(deBruijn32tab[(x&-x)*deBruijn32>>(32-5)])
}

// TrailingZeros64返回x中的尾随零位数；对于x==0，结果为64。
func TrailingZeros64(x uint64) int {
	if x == 0 {
		return 64
	}
	// 如果popcount很快，请用返回的popcount（^x&（x-1））替换下面的代码。
	// 
	// x&-x只保留字中最右边的位集。设k为该位的
	// 索引。由于只设置了一个位，因此该值是k的幂的两个
	// 。乘以二的幂等于
	// 左移位，在本例中为k位。de Bruijn（64位）常量
	// 使得所有六位连续子串都是不同的。
	// 因此，如果我们有这个常数的左移版本，我们可以通过查看哪个六位
	// 子字符串位于单词的顶部来确定它的移位位数。
	// （克努特，第4卷，第7.3.1节）
	return int(deBruijn64tab[(x&-x)*deBruijn64>>(64-6)])
}

// --OneScont---

const m0 = 0x5555555555555555 // 01010101。。。
const m1 = 0x3333333333333333 // 00110011。。。
const m2 = 0x0f0f0f0f0f0f0f0f // 00001111。。。
const m3 = 0x00ff00ff00ff00ff // etc.
const m4 = 0x0000ffff0000ffff

// OneScont返回x中的一位数（“总体计数”）。
func OnesCount(x uint) int {
	if UintSize == 32 {
		return OnesCount32(uint32(x))
	}
	return OnesCount64(uint64(x))
}

// OneScont8返回x中的一位数（“总体计数”）。
func OnesCount8(x uint8) int {
	return int(pop8tab[x])
}

// OneScont16返回x中的一位数（“总体计数”）。
func OnesCount16(x uint16) int {
	return int(pop8tab[x>>8] + pop8tab[x&0xff])
}

// OneScont32返回x中的一位数（“总体计数”）。
func OnesCount32(x uint32) int {
	return int(pop8tab[x>>24] + pop8tab[x>>16&0xff] + pop8tab[x>>8&0xff] + pop8tab[x&0xff])
}

// OneScont64返回x中的一位数（“总体计数”）。
func OnesCount64(x uint64) int {
	// 实现：相邻位的并行求和。
	// 参见“黑客的喜悦”，第5章：计算比特数。
	// 以下模式显示了一般方法：
	// 
	// x=x>>1&（m0&m）+x&（m0&m）
	// x=x>>2&（m1&m）+x&（m1&m）
	// x=x>>32&（m5&m）+x&（m5&m）
	// return int（x）
	// 
	// 如果没有
	// 字段的和将结转到下一个
	// 字段的危险，则可以忽略屏蔽（和操作）：因为结果不能大于64，8位就足够了
	// 我们可以忽略8以上移位的掩码。
	// 根据《黑客之乐》，第一行可以简化
	// 更多，但它最多只能保存一条指令，因此为了清晰起见，我们将
	// 单独保留。
	const m = 1<<64 - 1
	x = x>>1&(m0&m) + x&(m0&m)
	x = x>>2&(m1&m) + x&(m1&m)
	x = (x>>4 + x) & (m2 & m)
	x += x >> 8
	x += x >> 16
	x += x >> 32
	return int(x) & (1<<7 - 1)
}

// /--RotateLeft---

// /RotateLeft返回x向左旋转（k mod UintSize）位的值。
// 若要将x向右旋转k位，请调用RotateLeft（x，-k）。
// 
// 此函数的执行时间不依赖于输入。
func RotateLeft(x uint, k int) uint {
	if UintSize == 32 {
		return uint(RotateLeft32(uint32(x), k))
	}
	return uint(RotateLeft64(uint64(x), k))
}

// RotateLeft8返回x向左旋转（k mod 8）位的值。
// 若要将x向右旋转k位，请调用RotateLeft8（x，-k）。
// 
// 此函数的执行时间不依赖于输入。
func RotateLeft8(x uint8, k int) uint8 {
	const n = 8
	s := uint(k) & (n - 1)
	return x<<s | x>>(n-s)
}

// RotateLeft16返回向左旋转（k mod 16）位的x值。
// 若要将x向右旋转k位，请调用RotateLeft16（x，-k）。
// 
// 此函数的执行时间不依赖于输入。
func RotateLeft16(x uint16, k int) uint16 {
	const n = 16
	s := uint(k) & (n - 1)
	return x<<s | x>>(n-s)
}

// RotateLeft32返回x向左旋转（k mod 32）位的值。
// 若要将x向右旋转k位，请调用RotateLeft32（x，-k）。
// 
// 此函数的执行时间不依赖于输入。
func RotateLeft32(x uint32, k int) uint32 {
	const n = 32
	s := uint(k) & (n - 1)
	return x<<s | x>>(n-s)
}

// RotateLeft64返回x向左旋转（k mod 64）位的值。
// 若要将x向右旋转k位，请调用RotateLeft64（x，-k）。
// 
// 此函数的执行时间不依赖于输入。
func RotateLeft64(x uint64, k int) uint64 {
	const n = 64
	s := uint(k) & (n - 1)
	return x<<s | x>>(n-s)
}

// /--Reverse--

// Reverse返回x的值，其位的顺序相反。
func Reverse(x uint) uint {
	if UintSize == 32 {
		return uint(Reverse32(uint32(x)))
	}
	return uint(Reverse64(uint64(x)))
}

// Reverse8返回x的值，其位的顺序相反。
func Reverse8(x uint8) uint8 {
	return rev8tab[x]
}

// Reverse16返回x的值，其位的顺序相反。
func Reverse16(x uint16) uint16 {
	return uint16(rev8tab[x>>8]) | uint16(rev8tab[x&0xff])<<8
}

// Reverse32返回x的值及其位的顺序相反。
func Reverse32(x uint32) uint32 {
	const m = 1<<32 - 1
	x = x>>1&(m0&m) | x&(m0&m)<<1
	x = x>>2&(m1&m) | x&(m1&m)<<2
	x = x>>4&(m2&m) | x&(m2&m)<<4
	return ReverseBytes32(x)
}

// Reverse64返回x的值及其位的顺序相反。
func Reverse64(x uint64) uint64 {
	const m = 1<<64 - 1
	x = x>>1&(m0&m) | x&(m0&m)<<1
	x = x>>2&(m1&m) | x&(m1&m)<<2
	x = x>>4&(m2&m) | x&(m2&m)<<4
	return ReverseBytes64(x)
}

// /--ReverseBytes--

// /ReverseBytes返回x的值，其字节顺序相反。
// 
// 此函数的执行时间不依赖于输入。
func ReverseBytes(x uint) uint {
	if UintSize == 32 {
		return uint(ReverseBytes32(uint32(x)))
	}
	return uint(ReverseBytes64(uint64(x)))
}

// ReverseBytes 16返回x的值及其字节的顺序相反。
// 
// 此函数的执行时间不依赖于输入。
func ReverseBytes16(x uint16) uint16 {
	return x>>8 | x<<8
}

// ReverseBytes 32返回x的值及其字节的顺序相反。
// 
// 此函数的执行时间不依赖于输入。
func ReverseBytes32(x uint32) uint32 {
	const m = 1<<32 - 1
	x = x>>8&(m3&m) | x&(m3&m)<<8
	return x>>16 | x<<16
}

// ReverseBytes 64返回x的值及其字节的顺序相反。
// 
// 此函数的执行时间不依赖于输入。
func ReverseBytes64(x uint64) uint64 {
	const m = 1<<64 - 1
	x = x>>8&(m3&m) | x&(m3&m)<<8
	x = x>>16&(m4&m) | x&(m4&m)<<16
	return x>>32 | x<<32
}

// /--Len---

// Len返回表示x所需的最小位数；对于x==0，结果为0。
func Len(x uint) int {
	if UintSize == 32 {
		return Len32(uint32(x))
	}
	return Len64(uint64(x))
}

// Len8返回表示x所需的最小位数；对于x==0，结果为0。
func Len8(x uint8) int {
	return int(len8tab[x])
}

// Len16返回表示x所需的最小位数；对于x==0，结果为0。
func Len16(x uint16) (n int) {
	if x >= 1<<8 {
		x >>= 8
		n = 8
	}
	return n + int(len8tab[x])
}

// Len32返回表示x所需的最小位数；对于x==0，结果为0。
func Len32(x uint32) (n int) {
	if x >= 1<<16 {
		x >>= 16
		n = 16
	}
	if x >= 1<<8 {
		x >>= 8
		n += 8
	}
	return n + int(len8tab[x])
}

// Len64返回表示x所需的最小位数；对于x==0，结果为0。
func Len64(x uint64) (n int) {
	if x >= 1<<32 {
		x >>= 32
		n = 32
	}
	if x >= 1<<16 {
		x >>= 16
		n += 16
	}
	if x >= 1<<8 {
		x >>= 8
		n += 8
	}
	return n + int(len8tab[x])
}

// --带进位加法---

// Add返回带进位x、y和进位的和：sum=x+y+进位。
// 进位输入必须为0或1；否则，行为是未定义的。
// 结转输出保证为0或1。
// 
// 此函数的执行时间不依赖于输入。
func Add(x, y, carry uint) (sum, carryOut uint) {
	if UintSize == 32 {
		s32, c32 := Add32(uint32(x), uint32(y), uint32(carry))
		return uint(s32), uint(c32)
	}
	s64, c64 := Add64(uint64(x), uint64(y), uint64(carry))
	return uint(s64), uint(c64)
}

// Add32返回进位为x，y和进位的和：sum=x+y+进位。
// 进位输入必须为0或1；否则，行为是未定义的。
// 结转输出保证为0或1。
// 
// 此函数的执行时间不依赖于输入。
func Add32(x, y, carry uint32) (sum, carryOut uint32) {
	sum64 := uint64(x) + uint64(y) + uint64(carry)
	sum = uint32(sum64)
	carryOut = uint32(sum64 >> 32)
	return
}

// Add64返回进位为x，y和进位的和：sum=x+y+进位。
// 进位输入必须为0或1；否则，行为是未定义的。
// 结转输出保证为0或1。
// 
// 此函数的执行时间不依赖于输入。
func Add64(x, y, carry uint64) (sum, carryOut uint64) {
	sum = x + y + carry
	// 如果设置了两个高位（x&y）或其中一个
	// 为（x | y），并且发生了低位进位，则总和将溢出。如果发生这种进位
	// 的情况，则最高位为1+0+1=0（&^sum）。
	carryOut = ((x & y) | ((x | y) &^ sum)) >> 63
	return
}

// --带借阅的减法---

// /Sub返回x、y和借阅的差值：diff=x-y-借阅。
// 借入输入必须为0或1；否则，行为是未定义的。
// 借入输出保证为0或1。
// 
// 此函数的执行时间不依赖于输入。
func Sub(x, y, borrow uint) (diff, borrowOut uint) {
	if UintSize == 32 {
		d32, b32 := Sub32(uint32(x), uint32(y), uint32(borrow))
		return uint(d32), uint(b32)
	}
	d64, b64 := Sub64(uint64(x), uint64(y), uint64(borrow))
	return uint(d64), uint(b64)
}

// Sub32返回x，y和借入的差值，diff=x-y-借入。
// 借入输入必须为0或1；否则，行为是未定义的。
// 借入输出保证为0或1。
// 
// 此函数的执行时间不依赖于输入。
func Sub32(x, y, borrow uint32) (diff, borrowOut uint32) {
	diff = x - y - borrow
	// 如果没有设置x的顶部位，并且设置了y的顶部位（^x&y），或者如果它们相同（^（x^y）），并且发生从较低位置借用
	// 的情况，则差异将下溢。如果借贷发生，结果将是
	// 1-1-1=0-0-1=1（&diff）。
	borrowOut = ((^x & y) | (^(x ^ y) & diff)) >> 31
	return
}

// Sub64返回x、y和借阅的差值：diff=x-y-borrow。
// 借入输入必须为0或1；否则，行为是未定义的。
// 借入输出保证为0或1。
// 
// 此函数的执行时间不依赖于输入。
func Sub64(x, y, borrow uint64) (diff, borrowOut uint64) {
	diff = x - y - borrow
	// 位逻辑见Sub32。
	borrowOut = ((^x & y) | (^(x ^ y) & diff)) >> 63
	return
}

// --全宽乘法--

// Mul返回x和y的全宽乘积：（hi，lo）=x*y 
// ，乘积位的上半部分在hi中返回，下半部分在lo中返回。
// 
// 此函数的执行时间不依赖于输入。
func Mul(x, y uint) (hi, lo uint) {
	if UintSize == 32 {
		h, l := Mul32(uint32(x), uint32(y))
		return uint(h), uint(l)
	}
	h, l := Mul64(uint64(x), uint64(y))
	return uint(h), uint(l)
}

// Mul32返回x和y的64位乘积：（hi，lo）=x*y 
// 乘积位的上半部分以hi返回，下半部分以lo返回。
// 
// 此函数的执行时间不依赖于输入。
func Mul32(x, y uint32) (hi, lo uint32) {
	tmp := uint64(x) * uint64(y)
	hi, lo = uint32(tmp>>32), uint32(tmp)
	return
}

// Mul64返回x和y的128位乘积：（hi，lo）=x*y 
// 乘积位的上半部分以hi返回，下半部分以lo返回。
// 
// 此函数的执行时间不依赖于输入。
func Mul64(x, y uint64) (hi, lo uint64) {
	const mask32 = 1<<32 - 1
	x0 := x & mask32
	x1 := x >> 32
	y0 := y & mask32
	y1 := y >> 32
	w0 := x0 * y0
	t := x1*y0 + w0>>32
	w1 := t & mask32
	w2 := t >> 32
	w1 += x0 * y1
	hi = x1*y1 + w2 + w1>>32
	lo = x * y
	return
}

// --全宽除法---

// Div返回（hi，lo）除以y的商和余数：
// quo=（hi，lo）/y，rem=（hi，lo）%y，其中被除数位的上半部分在参数hi中，下半部分在参数lo中。
// y==0（除零）或y<=hi（商溢出）的Div恐慌。
func Div(hi, lo, y uint) (quo, rem uint) {
	if UintSize == 32 {
		q, r := Div32(uint32(hi), uint32(lo), uint32(y))
		return uint(q), uint(r)
	}
	q, r := Div64(uint64(hi), uint64(lo), uint64(y))
	return uint(q), uint(r)
}

// Div32返回（hi，lo）除以y的商和余数：
// quo=（hi，lo）/y，rem=（hi，lo）%y，其中被除数位的上半部分在参数hi中，下半部分在参数lo中。
// y==0（除零）或y<=hi（商溢出）的Div32位恐慌。
func Div32(hi, lo, y uint32) (quo, rem uint32) {
	if y != 0 && y <= hi {
		panic(overflowError)
	}
	z := uint64(hi)<<32 | uint64(lo)
	quo, rem = uint32(z/uint64(y)), uint32(z%uint64(y))
	return
}

// Div64返回（hi，lo）除以y的商和余数：
// quo=（hi，lo）/y，rem=（hi，lo）%y，其中被除数位的上半部分
// 在参数hi中，下半部分在参数lo中。
// /y==0（除零）或y<=hi（商溢出）的Div64位恐慌。
func Div64(hi, lo, y uint64) (quo, rem uint64) {
	const (
		two32  = 1 << 32
		mask32 = two32 - 1
	)
	if y == 0 {
		panic(divideError)
	}
	if y <= hi {
		panic(overflowError)
	}

	s := uint(LeadingZeros64(y))
	y <<= s

	yn1 := y >> 32
	yn0 := y & mask32
	un32 := hi<<s | lo>>(64-s)
	un10 := lo << s
	un1 := un10 >> 32
	un0 := un10 & mask32
	q1 := un32 / yn1
	rhat := un32 - q1*yn1

	for q1 >= two32 || q1*yn0 > two32*rhat+un1 {
		q1--
		rhat += yn1
		if rhat >= two32 {
			break
		}
	}

	un21 := un32*two32 + un1 - q1*y
	q0 := un21 / yn1
	rhat = un21 - q0*yn1

	for q0 >= two32 || q0*yn0 > two32*rhat+un0 {
		q0--
		rhat += yn1
		if rhat >= two32 {
			break
		}
	}

	return q1*two32 + q0, (un21*two32 + un0 - q0*y) >> s
}

// Rem返回（hi，lo）除以y的余数。Rem对
// y==0（除零）感到恐慌，但与Div不同，它不会对
// 商溢出感到恐慌。
func Rem(hi, lo, y uint) uint {
	if UintSize == 32 {
		return uint(Rem32(uint32(hi), uint32(lo), uint32(y)))
	}
	return uint(Rem64(uint64(hi), uint64(lo), uint64(y)))
}

// Rem32返回（hi，lo）除以y的余数。Rem32对y==0（除零）使
// 恐慌，但与Div32不同，它不会对商溢出使
// 恐慌。
func Rem32(hi, lo, y uint32) uint32 {
	return uint32((uint64(hi)<<32 | uint64(lo)) % uint64(y))
}

// Rem64返回（hi，lo）除以y的余数。Rem64使y==0（除零）的
// 恐慌，但与Div64不同，它不会使商溢出的
// 恐慌。
func Rem64(hi, lo, y uint64) uint64 {
	// 我们将hi缩小到hi<y，然后使用Div64计算
	// rem，保证它不会在商溢出时死机。
	// 鉴于
	// 嗨≡ 您好%y（mod y）
	// 我们有
	// 您好<<64+lo≡ （高%y）<<64+lo（y型）
	_, rem := Div64(hi%y, lo, y)
	return rem
}
